Inside Macintosh: QuickDraw GX Objects /

Chapter 7 - View-Related Objects / View-Related Objects Reference

View Device Functions / Manipulating View Device Object Properties

GXGetViewDeviceClip

You can use the GXGetViewDeviceClip function to examine the clip property of a view device object.

gxShape GXGetViewDeviceClip(gxViewDevice source);

source

A reference to the view device whose clip you wish to examine.

function result

A reference to a shape object whose geometry defines the view device's clip.

DESCRIPTION

The GXGetViewDeviceClip function returns a shape object that defines the geometry of the clip associated with the view device. The function returns nil if there is no clip. The clip shape is a copy of the view device's clip; changing this shape does not change the view device's clip.

SPECIAL CONSIDERATIONS

If no error occurs, the GXGetViewDeviceClip function creates a shape object; you are responsible for disposing of that object when you no longer need it.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
invalid_viewDevice_reference

SEE ALSO

To set a view device's clip, use the GXSetViewDeviceClip function, described next.